Dialog Max Retry Count JSON Reference
| Declared in | Voiceflow.schema.json |
Overview
Specifies the parameters for maximum retry counts in a dialog to collect input from a User that translates to a valid SR Hypothesis or a valid User Intent.
Note: Unless stated otherwise, value of properties that are of type "string" can be updated at runtime by an application if their value is entered as a field name wrapped by "$[" and "]". If a property is of a type other than "string", then an additional property of type "string" with the same property name appended with the string "Runtime" is added to have its value entered as a field name wrapped by "$[" and "]". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.
Tasks
-
timeoutpropertyMaximum threshold count of retries for no input or silence from User. The value can be set at runtime using the
"timeoutRuntime"property.Parameter is required.
-
timeoutRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"timeout"property. Example:"$[Timeout]".Parameter is optional.
-
garbagepropertyMaximum threshold count of retries for invalid or unreceognizable input from User. The value can be set at runtime using the
"garbageRuntime"property.Parameter is required.
-
garbageRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"garbage"property. Example:"$[Garbage]".Parameter is optional.
-
sr_errorpropertyMaximum threshold count of retries for errors encountered with speech recognition. The value can be set at runtime using the
"sr_errorRuntime"property.Parameter is required.
-
sr_errorRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"sr_error"property. Example:"$[SR_error]".Parameter is optional.
-
totalRetrypropertyMaximum threshold count of total retries inclusive of retry counts from
"garbage","timeout"and"sr_error". The value can be set at runtime using the"totalRetryRuntime"property.Parameter is required.
-
totalRetryRuntimepropertyContains the name of a field, as a string wrapped between
"$["and"]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the"totalRetry"property. Example:"$[totalRetry]".Parameter is optional.
Properties
garbage
"garbage": integer
Discussion
Maximum threshold count of retries for invalid or unreceognizable input from User. The value can be set at runtime using the "garbageRuntime" property.
Parameter is required.
Declared In
Voiceflow.schema.json
garbageRuntime
"garbageRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "garbage" property. Example: "$[Garbage]".
Parameter is optional.
Declared In
Voiceflow.schema.json
sr_error
"sr_error": integer
Discussion
Maximum threshold count of retries for errors encountered with speech recognition. The value can be set at runtime using the "sr_errorRuntime" property.
Parameter is required.
Declared In
Voiceflow.schema.json
sr_errorRuntime
"sr_errorRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "sr_error" property. Example: "$[SR_error]".
Parameter is optional.
Declared In
Voiceflow.schema.json
timeout
"timeout": integer
Discussion
Maximum threshold count of retries for no input or silence from User. The value can be set at runtime using the "timeoutRuntime" property.
Parameter is required.
Declared In
Voiceflow.schema.json
timeoutRuntime
"timeoutRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "timeout" property. Example: "$[Timeout]".
Parameter is optional.
Declared In
Voiceflow.schema.json
totalRetry
"totalRetry": integer
Discussion
Maximum threshold count of total retries inclusive of retry counts from "garbage", "timeout" and "sr_error". The value can be set at runtime using the "totalRetryRuntime" property.
Parameter is required.
Declared In
Voiceflow.schema.json
totalRetryRuntime
"totalRetryRuntime": string
Discussion
Contains the name of a field, as a string wrapped between "$[" and "]", whose integer value can be set at runtime by an application. If the value of the field is a valid integer, then it will replace the value entered in the "totalRetry" property. Example: "$[totalRetry]".
Parameter is optional.
Declared In
Voiceflow.schema.json